home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / layout / nsIFrameTraversal.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  3KB  |  96 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37. #ifndef NSIFRAMETRAVERSAL_H
  38. #define NSIFRAMETRAVERSAL_H
  39.  
  40. #include "nsISupports.h"
  41. #include "nsIEnumerator.h"
  42. #include "nsIFrame.h"
  43.  
  44. /* Brief explanation of frame traversal types:
  45.  *
  46.  * LEAF:
  47.  *  Iterate over only the leaf frames in the tree, in depth-first order.
  48.  *
  49.  * EXTENSIVE:
  50.  *  Iterate over all frames in the tree, including non-leaf frames.
  51.  *  Child frames are traversed before their parents going both forward
  52.  *  and backward.
  53.  *
  54.  * FOCUS:
  55.  *  Traverse frames in "focus" order, which is like extensive but
  56.  *  does a strict preorder traversal in both directions.  This type of
  57.  *  traversal also handles placeholder frames transparently, meaning that
  58.  *  it will never stop on one - going down will get the real frame, going
  59.  *  back up will go on past the placeholder, so the placeholders are logically
  60.  *  part of the frame tree.
  61.  *
  62.  * FASTEST:
  63.  *  XXX not implemented
  64.  *
  65.  * VISUAL:
  66.  *  Traverse frames in "visual" order (left-to-right, top-to-bottom).
  67.  */
  68.  
  69. enum nsTraversalType{
  70.   LEAF,
  71.   EXTENSIVE,
  72.   FOCUS,
  73.   FASTEST
  74. #ifdef IBMBIDI // Simon
  75.    , VISUAL
  76. #endif
  77. }; 
  78.  
  79. // {1691E1F3-EE41-11d4-9885-00C04FA0CF4B}
  80. #define NS_IFRAMETRAVERSAL_IID \
  81. { 0x1691e1f3, 0xee41, 0x11d4, { 0x98, 0x85, 0x0, 0xc0, 0x4f, 0xa0, 0xcf, 0x4b } }
  82.  
  83. class nsIFrameTraversal : public nsISupports
  84. {
  85. public:
  86.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFRAMETRAVERSAL_IID)
  87.  
  88.   NS_IMETHOD NewFrameTraversal(nsIBidirectionalEnumerator **aEnumerator,
  89.                               PRUint32 aType,
  90.                               nsPresContext* aPresContext,
  91.                               nsIFrame *aStart) = 0;
  92. };
  93.  
  94.  
  95. #endif //NSIFRAMETRAVERSAL_H
  96.